/*
 * CCVisu is a tool for visual graph clustering
 * and general force-directed graph layout.
 * This file is part of CCVisu.
 *
 * Copyright (C) 2005-2011  Dirk Beyer
 *
 * CCVisu is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * CCVisu is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with CCVisu; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Please find the GNU Lesser General Public License in file
 * license_lgpl.txt or http://www.gnu.org/licenses/lgpl.txt
 *
 * Dirk Beyer    (firstname.lastname@uni-passau.de)
 * University of Passau, Bavaria, Germany
 */
package org.sosy_lab.ccvisu.readers;

import java.io.BufferedReader;
import java.io.File;
import java.util.StringTokenizer;

import javax.swing.filechooser.FileFilter;

import org.sosy_lab.ccvisu.graph.GraphData;
import org.sosy_lab.ccvisu.writers.OutputFormat;
import org.sosy_lab.common.LogManager;

/**
 * Reader for input data.
 */
public abstract class ReaderData {

  /** Input stream reader object. */
  protected final BufferedReader reader;

  protected final LogManager     logger;

  /**
   * Constructor.
   * @param logger      the log manager
   * @param reader      Stream reader object.
   */
  public ReaderData(LogManager logger, BufferedReader reader) {
    assert(logger != null && reader != null);

    this.reader = reader;
    this.logger = logger;
  }

  /**
   * Reads the graph or layout data from stream reader <code>reader</code>.
   * @param graph  <code>GraphData</code> object to store the read graph or
   *               layout data in.
   */
  abstract public void read(GraphData graph);

  // Helper.
  protected String readEntry(StringTokenizer st) {
    assert(st != null);

    String result = st.nextToken();
    if (result.charAt(0) == '"') {
      while (result.charAt(result.length() - 1) != '"') {
        result = result + ' ' + st.nextToken();
      }
      result = result.substring(1, result.length() - 1);
    }
    return result;
  }

  public static FileFilter mkExtensionFileFilter(final InputFormat inputFormat) {
    return ReaderData.mkExtensionFileFilter(inputFormat.getFileExtension(),
        inputFormat.getFileType());
  }

  public static FileFilter mkExtensionFileFilter(final OutputFormat outputFormat) {
    return ReaderData.mkExtensionFileFilter(outputFormat.getFileExtension(),
        outputFormat.getFileType());
  }

  public static FileFilter mkExtensionFileFilter(final String extension,
      final String description) {

    return new FileFilter() {
      @Override
      public boolean accept(File file) {
        return file.getName().endsWith(extension);
      }

      @Override
      public String getDescription() {
        return description;
      }
    };
  }
}
